<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
                "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
  <title>Description of add_coriolis</title>
  <meta name="keywords" content="add_coriolis">
  <meta name="description" content="Generate latitude used for FVCOM Coriolis file">
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  <meta name="generator" content="m2html v1.5 &copy; 2003-2005 Guillaume Flandin">
  <meta name="robots" content="index, follow">
  <link type="text/css" rel="stylesheet" href="../m2html.css">
</head>
<body>
<a name="_top"></a>
<div><a href="../index.html">Home</a> &gt;  <a href="index.html">fvcom_prepro</a> &gt; add_coriolis.m</div>

<!--<table width="100%"><tr><td align="left"><a href="../index.html"><img alt="<" border="0" src="../left.png">&nbsp;Master index</a></td>
<td align="right"><a href="index.html">Index for fvcom_prepro&nbsp;<img alt=">" border="0" src="../right.png"></a></td></tr></table>-->

<h1>add_coriolis
</h1>

<h2><a name="_name"></a>PURPOSE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
<div class="box"><strong>Generate latitude used for FVCOM Coriolis file</strong></div>

<h2><a name="_synopsis"></a>SYNOPSIS <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
<div class="box"><strong>function [Mobj] = add_coriolis(Mobj,cortype,fval) </strong></div>

<h2><a name="_description"></a>DESCRIPTION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
<div class="fragment"><pre class="comment"> Generate latitude used for FVCOM Coriolis file 

 [Mobj] = function add_coriolis(Mobj,varargin)

 DESCRIPTION:
    add Coriolis parameter to Matlab mesh object

 INPUT 
   Mobj                   = matlab mesh object 
   [optional] cortype      = coriolis type 
                             'uselatitude' (default): use Mobj.lat
                             'constant'        
   [optional] fval         = constant latitude for constant Coriolis

 OUTPUT:
    Mobj = matlab structure containing Mesh data + fvcom Coriolis

 EXAMPLE USAGE
    Mobj = add_coriolis(Mobj,'constant',41.0) 
    Mobj = add_coriolis(Mobj) 

 Author(s):  
    Geoff Cowles (University of Massachusetts Dartmouth)

 Revision history
   
==============================================================================</pre></div>

<!-- crossreference -->
<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
This function calls:
<ul style="list-style-image:url(../matlabicon.gif)">
</ul>
This function is called by:
<ul style="list-style-image:url(../matlabicon.gif)">
<li><a href="example.html" class="code" title="">example</a>	example demonstrating reading in a 2DM file and constructing a model</li></ul>
<!-- crossreference -->



<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
<div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function [Mobj] = add_coriolis(Mobj,cortype,fval) </a>
0002 
0003 <span class="comment">% Generate latitude used for FVCOM Coriolis file</span>
0004 <span class="comment">%</span>
0005 <span class="comment">% [Mobj] = function add_coriolis(Mobj,varargin)</span>
0006 <span class="comment">%</span>
0007 <span class="comment">% DESCRIPTION:</span>
0008 <span class="comment">%    add Coriolis parameter to Matlab mesh object</span>
0009 <span class="comment">%</span>
0010 <span class="comment">% INPUT</span>
0011 <span class="comment">%   Mobj                   = matlab mesh object</span>
0012 <span class="comment">%   [optional] cortype      = coriolis type</span>
0013 <span class="comment">%                             'uselatitude' (default): use Mobj.lat</span>
0014 <span class="comment">%                             'constant'</span>
0015 <span class="comment">%   [optional] fval         = constant latitude for constant Coriolis</span>
0016 <span class="comment">%</span>
0017 <span class="comment">% OUTPUT:</span>
0018 <span class="comment">%    Mobj = matlab structure containing Mesh data + fvcom Coriolis</span>
0019 <span class="comment">%</span>
0020 <span class="comment">% EXAMPLE USAGE</span>
0021 <span class="comment">%    Mobj = add_coriolis(Mobj,'constant',41.0)</span>
0022 <span class="comment">%    Mobj = add_coriolis(Mobj)</span>
0023 <span class="comment">%</span>
0024 <span class="comment">% Author(s):</span>
0025 <span class="comment">%    Geoff Cowles (University of Massachusetts Dartmouth)</span>
0026 <span class="comment">%</span>
0027 <span class="comment">% Revision history</span>
0028 <span class="comment">%</span>
0029 <span class="comment">%==============================================================================</span>
0030 <span class="keyword">global</span> ftbverbose
0031 subname = <span class="string">'add_coriolis'</span>;
0032 <span class="keyword">if</span>(ftbverbose)
0033   fprintf(<span class="string">'\n'</span>)
0034   fprintf([<span class="string">'begin : '</span> subname <span class="string">'\n'</span>])
0035 <span class="keyword">end</span>;
0036 
0037 <span class="comment">%------------------------------------------------------------------------------</span>
0038 <span class="comment">% Parse arguments</span>
0039 <span class="comment">%------------------------------------------------------------------------------</span>
0040 CorType = <span class="string">'uselatitude'</span>;
0041 <span class="keyword">if</span>(exist(<span class="string">'cortype'</span>))
0042     <span class="keyword">if</span>(cortype(1:3)==<span class="string">'use'</span>)
0043         CorType = <span class="string">'uselatitude'</span>;
0044         <span class="keyword">if</span>(~Mobj.have_cor)
0045             error(<span class="string">'To set Coriolis with latitude, need (lon,lat) field in Mesh structure'</span>)
0046         <span class="keyword">end</span>;
0047     <span class="keyword">else</span>
0048         CorType = <span class="string">'constant'</span>;
0049         <span class="keyword">if</span>(~exist(<span class="string">'fval'</span>))
0050             error(<span class="string">'must provide a constant latitude for constant coriolis option'</span>);
0051         <span class="keyword">end</span>;
0052     <span class="keyword">end</span>;
0053 <span class="keyword">end</span>;
0054 
0055 <span class="comment">%------------------------------------------------------------------------------</span>
0056 <span class="comment">% Set Coriolis</span>
0057 <span class="comment">%------------------------------------------------------------------------------</span>
0058 <span class="keyword">if</span>(CorType(1:3) == <span class="string">'use'</span>)
0059     <span class="keyword">if</span>(ftbverbose); fprintf(<span class="string">'setting Coriolis to latitude\n'</span>);<span class="keyword">end</span>;
0060     Mobj.f = Mobj.lat;
0061 <span class="keyword">end</span>;
0062 
0063 <span class="keyword">if</span>(CorType(1:3) == <span class="string">'con'</span>)
0064     <span class="keyword">if</span>(ftbverbose); fprintf(<span class="string">'setting Coriolis to constant %f\n'</span>,fval); <span class="keyword">end</span>;
0065     Mobj.f = fval*ones(Mobj.nVerts,1);
0066 <span class="keyword">end</span>;
0067 
0068 Mobj.have_cor = true;
0069 
0070 <span class="keyword">if</span>(ftbverbose)
0071   fprintf([<span class="string">'end   : '</span> subname <span class="string">'\n'</span>])
0072 <span class="keyword">end</span>;
0073 
0074 
0075 
0076</pre></div>
<hr><address>Generated on Wed 02-Nov-2011 21:58:00 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/" title="Matlab Documentation in HTML">m2html</a></strong> &copy; 2005</address>
</body>
</html>